home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / libs / quickhelp.lha / QuickHelp / QuickHelp_lib / QuickHelp.doc < prev    next >
Encoding:
Text File  |  1998-01-18  |  3.2 KB  |  122 lines
  1. TABLE OF CONTENTS
  2. quickhelp.library/OpenHelp
  3. quickhelp.library/CloseHelp
  4. quickhelp.library/GetQuickHelpString
  5. quickhelp.library/OpenHelp                                     quickhelp.library/OpenHelp
  6.  
  7.    NAME
  8.     OpenHelpA -- Otwórz okno pomocy.  (V37)
  9.     OpenHelp
  10.  
  11.    SYNOPSIS
  12.     status = OpenHelpA( text, helpfont, app_window, taglist )
  13.     D0                 A0    A1        A2                     A3
  14.  
  15.     BOOL OpenHelpA( STRPTR, struct TextFont *, struct Window *, struct TagItem * );
  16.  
  17.     status = OpenHelp( text, helpfont, app_window, tag1, ,,, )
  18.  
  19.     BOOL OpenHelp( STRPTR, struct TextFont *, struct Window *, ULONG, ... );
  20.  
  21.    FUNCTION
  22.     Funkcja otwiera okno pomocy pod gadgetem
  23.  
  24.    TAGS
  25.   OH_PozX -- pozycja X w pikselach okna pomocy
  26.   OH_PozY -- pozycja Y w pikselach okna pomocy
  27.  
  28.    NOTE
  29.     Jako helpfont naleûy podaê adres struktury TextFont. Czcionka ta
  30.     nie musi byê taka jak czcionka okna aplikacji ( app_window ), jednak
  31.     dla wygody przy pisaniu programu zalecane jest aby czcionki te byîy
  32.     takie same, gdyû przed wywoîaniem tej funkcji w RastPorcie okna aplikacji
  33.     ( app_window ) MUSI byê ustawiony font helpfont.
  34.     Jeôli nie zostaîy podane tagi OH_PozX i OH_PozY pozycja okna pomocy zostanie
  35.     pobrana z pozycji wskaúnika myszki.
  36.  
  37.    EXAMPLE
  38.     Przykîad 1: ta sama czcionka
  39.     
  40.     SetFont( app_window->RPort, helpfont );
  41.     ...
  42.     case GD_BLA:
  43.         CloseHelp();
  44.         status = OpenHelp("To jest gadget BLA", helpfont, app_window, TAG_DONE);
  45.     break;
  46.     ...
  47.  
  48.     Przykîad 2: róûne czcionki
  49.         
  50.     SetFont( app_window->RPort, app_windowfont );
  51.     ...
  52.     case GD_BLA:
  53.     SetFont( app_window->RPort, helpfont );
  54.         CloseHelp();
  55.         status = OpenHelp("To jest gadget BLA", helpfont, app_window, TAG_DONE);
  56.     SetFont( app_window->RPort, app_windowfont );
  57.     break;
  58.     ...
  59.  
  60.    INPUTS
  61.     text -- tekst pomocy. W tekôcie tym moûna uûywaê znaku nowej linii '\n'.
  62.           Moûna uûyê maksymalnie 9 znaków '\n'. Jeûeli liczba ta zostanie
  63.           przekroczona to zamiast odpowiedniego tekstu zostanie wyôwietlony
  64.           napis "Zaduûo znaków nowej linii".
  65.  
  66.     helpfont -- adres struktury TextFont dla naszej pomocy.
  67.     app_window -- adres okna naszej aplikacji z gadgetami.
  68.     taglist -- adres struktury TagItem
  69.  
  70.    RESULTS
  71.     status -- TRUE jeôli okno pomocy otwarte, FALSE jeôli nie.
  72. quickhelp.library/CloseHelp                                 quickhelp.library/CloseHelp
  73.  
  74.    NAME
  75.     CloseHelp -- Zamknij okno pomocy.  (V37)
  76.  
  77.    SYNOPSIS
  78.     CloseHelp()
  79.     
  80.     void CloseHelp( void );
  81.  
  82.    FUNCTION
  83.     Funkcja zamyka okno pomocy.
  84.  
  85. quickhelp.library/GetQuickHelpString                                 quickhelp.library/GetQuickHelpString
  86.  
  87.    NAME
  88.     GetQuickHelpString -- Pobierz komunikat o ewentualnym bîëdzie.  (V37)
  89.  
  90.    SYNOPSIS
  91.     string = GetQuickHelpString()
  92.     D0
  93.  
  94.     STRPTR GetQuickHelpString( void );
  95.  
  96.    FUNCTION
  97.     Funkcja zwraca wskaúnik na string zawierajâcy odpowiedni komunikat
  98.     o bîëdzie lub NULL jeôli bîâd nie wystâpiî.
  99.  
  100.    EXAMPLE
  101.     ...
  102.     QuickHelpBase=OpenLibrary("quickhelp.library",37);
  103.     /*sprawdzamy czy nie wystâpiî bîâd */
  104.     if(GetQuickHelpString())
  105.         printf("%s\n",GetQuickHelpString());
  106.     ...
  107.  
  108.     oraz
  109.  
  110.     ...
  111.   case GD_MYGADGET:
  112.         CloseHelp();
  113.         if(!(status=OpenHelp("MyGadget help", MyFont, MyWindow)))
  114.         {
  115.             printf("%s\n",GetQuickHelpString());
  116.         }
  117.     break;
  118.  
  119.    RESULTS
  120.   string -- wskaúnik na odpowiedni komunikat.
  121.  
  122.